<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>ColumnMap xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/torque/map/ColumnMap.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../org/apache/torque/map/package-summary.html">org.apache.torque.map</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.Collections;
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.Iterator;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.Map;
<a name="25" href="#25">25</a>  
<a name="26" href="#26">26</a>  <strong>import</strong> org.apache.commons.collections.map.ListOrderedMap;
<a name="27" href="#27">27</a>  
<a name="28" href="#28">28</a>  <em>/**<em>*</em></em>
<a name="29" href="#29">29</a>  <em> * ColumnMap is used to model a column of a table in a database.</em>
<a name="30" href="#30">30</a>  <em> * &lt;p></em>
<a name="31" href="#31">31</a>  <em> * Note that this information should be set via the &lt;Table>MapBuilder class and</em>
<a name="32" href="#32">32</a>  <em> * not changed by applications. The set methods are only public because this</em>
<a name="33" href="#33">33</a>  <em> * class needs them.</em>
<a name="34" href="#34">34</a>  <em> *</em>
<a name="35" href="#35">35</a>  <em> * @author &lt;a href="<a href="mailto:jmcnally@collab.net" target="alexandria_uri">mailto:jmcnally@collab.net</a>">John D. McNally&lt;/a></em>
<a name="36" href="#36">36</a>  <em> * @author &lt;a href="<a href="mailto:greg.monroe@dukece.com" target="alexandria_uri">mailto:greg.monroe@dukece.com</a>">Greg Monroe&lt;/a></em>
<a name="37" href="#37">37</a>  <em> * @version $Id: ColumnMap.java 473821 2006-11-11 22:37:25Z tv $</em>
<a name="38" href="#38">38</a>  <em> */</em>
<a name="39" href="#39">39</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/torque/map/ColumnMap.html">ColumnMap</a> implements java.io.Serializable
<a name="40" href="#40">40</a>  {
<a name="41" href="#41">41</a>      <em>/**<em>* The serialVersionUID for this class. */</em></em>
<a name="42" href="#42">42</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>long</strong> serialVersionUID = -5971184507395399165L;
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>      <em>/**<em>* A sample object having the same java Type as the column. */</em></em>
<a name="45" href="#45">45</a>      <strong>private</strong> Object type = <strong>null</strong>;
<a name="46" href="#46">46</a>  
<a name="47" href="#47">47</a>      <em>/**<em>* The name of the Torque Type of the column. */</em></em>
<a name="48" href="#48">48</a>      <strong>private</strong> String torqueType = <strong>null</strong>;
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>      <em>/**<em>* Should object type be converted to primitive. */</em></em>
<a name="51" href="#51">51</a>      <strong>private</strong> <strong>boolean</strong> usePrimitive = <strong>true</strong>;
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>      <em>/**<em>* Size of the column. */</em></em>
<a name="54" href="#54">54</a>      <strong>private</strong> <strong>int</strong> size = 0;
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>      <em>/**<em>* Scale of the column */</em></em>
<a name="57" href="#57">57</a>      <strong>private</strong> <strong>int</strong> scale = 0;
<a name="58" href="#58">58</a>  
<a name="59" href="#59">59</a>      <em>/**<em>* Is it a primary key? */</em></em>
<a name="60" href="#60">60</a>      <strong>private</strong> <strong>boolean</strong> pk = false;
<a name="61" href="#61">61</a>  
<a name="62" href="#62">62</a>      <em>/**<em>* Is null value allowed ? */</em></em>
<a name="63" href="#63">63</a>      <strong>private</strong> <strong>boolean</strong> notNull = false;
<a name="64" href="#64">64</a>  
<a name="65" href="#65">65</a>      <em>/**<em>* Name of the table that this column is related to. */</em></em>
<a name="66" href="#66">66</a>      <strong>private</strong> String relatedTableName = <span class="string">""</span>;
<a name="67" href="#67">67</a>  
<a name="68" href="#68">68</a>      <em>/**<em>* Name of the column that this column is related to. */</em></em>
<a name="69" href="#69">69</a>      <strong>private</strong> String relatedColumnName = <span class="string">""</span>;
<a name="70" href="#70">70</a>  
<a name="71" href="#71">71</a>      <em>/**<em>* The <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> for this column. */</em></em>
<a name="72" href="#72">72</a>      <strong>private</strong> <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> table;
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>      <em>/**<em>* The name of the column. */</em></em>
<a name="75" href="#75">75</a>      <strong>private</strong> String columnName;
<a name="76" href="#76">76</a>  
<a name="77" href="#77">77</a>      <em>/**<em>*</em></em>
<a name="78" href="#78">78</a>  <em>     * The Java Name of this column as defined in XML or created by the</em>
<a name="79" href="#79">79</a>  <em>     * generator code.</em>
<a name="80" href="#80">80</a>  <em>     */</em>
<a name="81" href="#81">81</a>      <strong>private</strong> String javaName;
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>      <em>/**<em>* Is this column an autoincrement column ? */</em></em>
<a name="84" href="#84">84</a>      <strong>private</strong> <strong>boolean</strong> autoIncrement = false;
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>      <em>/**<em>* Column description info (if any). */</em></em>
<a name="87" href="#87">87</a>      <strong>private</strong> String description = <span class="string">""</span>;
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>      <em>/**<em>* is Column protected ? */</em></em>
<a name="90" href="#90">90</a>      <strong>private</strong> <strong>boolean</strong> isProtected = false;
<a name="91" href="#91">91</a>  
<a name="92" href="#92">92</a>      <em>/**<em>*</em></em>
<a name="93" href="#93">93</a>  <em>     * String representing the default value defined for field. Note that</em>
<a name="94" href="#94">94</a>  <em>     * default is a keyword, so defaultValue is used to store the value for the</em>
<a name="95" href="#95">95</a>  <em>     * get/setDefault() methods.</em>
<a name="96" href="#96">96</a>  <em>     */</em>
<a name="97" href="#97">97</a>      <strong>private</strong> String defaultValue = <strong>null</strong>;
<a name="98" href="#98">98</a>  
<a name="99" href="#99">99</a>      <em>/**<em>* Inheritance type used. */</em></em>
<a name="100" href="#100">100</a>     <strong>private</strong> String inheritance = <span class="string">"false"</span>;
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>     <em>/**<em>*</em></em>
<a name="103" href="#103">103</a> <em>     * Does column uses Inheritance subclasses? Note that this is tied to the</em>
<a name="104" href="#104">104</a> <em>     * TableMap useInheritance thru the set function.</em>
<a name="105" href="#105">105</a> <em>     */</em>
<a name="106" href="#106">106</a>     <strong>private</strong> <strong>boolean</strong> useInheritance;
<a name="107" href="#107">107</a> 
<a name="108" href="#108">108</a>     <em>/**<em>* Associated of inheritance maps. */</em></em>
<a name="109" href="#109">109</a>     <strong>private</strong> Map inheritanceMaps = Collections
<a name="110" href="#110">110</a>             .synchronizedMap(<strong>new</strong> ListOrderedMap());
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a>     <em>/**<em>* Input validator class name. (in DTD but not used?) */</em></em>
<a name="113" href="#113">113</a>     <strong>private</strong> String inputValidator;
<a name="114" href="#114">114</a> 
<a name="115" href="#115">115</a>     <em>/**<em>* Java naming method the generator used. */</em></em>
<a name="116" href="#116">116</a>     <strong>private</strong> String javaNamingMethod;
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>     <em>/**<em>* Java type string specified in XML. */</em></em>
<a name="119" href="#119">119</a>     <strong>private</strong> String javaType;
<a name="120" href="#120">120</a> 
<a name="121" href="#121">121</a>     <em>/**<em>* Column position in the table (one based). */</em></em>
<a name="122" href="#122">122</a>     <strong>private</strong> <strong>int</strong> position = -1;
<a name="123" href="#123">123</a> 
<a name="124" href="#124">124</a>     <em>/**<em>*</em></em>
<a name="125" href="#125">125</a> <em>     * Constructor.</em>
<a name="126" href="#126">126</a> <em>     *</em>
<a name="127" href="#127">127</a> <em>     * @param name The name of the column.</em>
<a name="128" href="#128">128</a> <em>     * @param containingTable TableMap of the table this column is in.</em>
<a name="129" href="#129">129</a> <em>     */</em>
<a name="130" href="#130">130</a>     <strong>public</strong> <a href="../../../../org/apache/torque/map/ColumnMap.html">ColumnMap</a>(String name, <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> containingTable)
<a name="131" href="#131">131</a>     {
<a name="132" href="#132">132</a>         table = containingTable;
<a name="133" href="#133">133</a>         <strong>this</strong>.columnName = normalizeName(name);
<a name="134" href="#134">134</a>     }
<a name="135" href="#135">135</a> 
<a name="136" href="#136">136</a>     <em>/**<em>*</em></em>
<a name="137" href="#137">137</a> <em>     * Makes sure that the column names don't include table prefixes. E.g.,</em>
<a name="138" href="#138">138</a> <em>     * SCARAB_PROJECT.PROJECT_ID should be PROJECT_ID.</em>
<a name="139" href="#139">139</a> <em>     *</em>
<a name="140" href="#140">140</a> <em>     * @param name The name to check</em>
<a name="141" href="#141">141</a> <em>     * @return The corrected name if needed or the same name if not.</em>
<a name="142" href="#142">142</a> <em>     */</em>
<a name="143" href="#143">143</a>     <strong>protected</strong> String normalizeName(String name)
<a name="144" href="#144">144</a>     {
<a name="145" href="#145">145</a>         <strong>if</strong> (name.indexOf('.') > 0)
<a name="146" href="#146">146</a>         {
<a name="147" href="#147">147</a>             <strong>return</strong> name.substring(name.lastIndexOf('.') + 1);
<a name="148" href="#148">148</a>         }
<a name="149" href="#149">149</a>         <strong>return</strong> name;
<a name="150" href="#150">150</a>     }
<a name="151" href="#151">151</a> 
<a name="152" href="#152">152</a>     <em>/**<em>*</em></em>
<a name="153" href="#153">153</a> <em>     * Get the name of a column.</em>
<a name="154" href="#154">154</a> <em>     *</em>
<a name="155" href="#155">155</a> <em>     * @return A String with the column name.</em>
<a name="156" href="#156">156</a> <em>     */</em>
<a name="157" href="#157">157</a>     <strong>public</strong> String getColumnName()
<a name="158" href="#158">158</a>     {
<a name="159" href="#159">159</a>         <strong>return</strong> columnName;
<a name="160" href="#160">160</a>     }
<a name="161" href="#161">161</a> 
<a name="162" href="#162">162</a>     <em>/**<em>*</em></em>
<a name="163" href="#163">163</a> <em>     * Get the table name + column name.</em>
<a name="164" href="#164">164</a> <em>     *</em>
<a name="165" href="#165">165</a> <em>     * @return A String with the full column name.</em>
<a name="166" href="#166">166</a> <em>     */</em>
<a name="167" href="#167">167</a>     <strong>public</strong> String getFullyQualifiedName()
<a name="168" href="#168">168</a>     {
<a name="169" href="#169">169</a>         <strong>return</strong> table.getName() + <span class="string">"."</span> + columnName;
<a name="170" href="#170">170</a>     }
<a name="171" href="#171">171</a> 
<a name="172" href="#172">172</a>     <em>/**<em>*</em></em>
<a name="173" href="#173">173</a> <em>     * Get the name of the table this column is in.</em>
<a name="174" href="#174">174</a> <em>     *</em>
<a name="175" href="#175">175</a> <em>     * @return A String with the table name.</em>
<a name="176" href="#176">176</a> <em>     */</em>
<a name="177" href="#177">177</a>     <strong>public</strong> String getTableName()
<a name="178" href="#178">178</a>     {
<a name="179" href="#179">179</a>         <strong>return</strong> table.getName();
<a name="180" href="#180">180</a>     }
<a name="181" href="#181">181</a> 
<a name="182" href="#182">182</a>     <em>/**<em>*</em></em>
<a name="183" href="#183">183</a> <em>     * Set the type of this column.</em>
<a name="184" href="#184">184</a> <em>     *</em>
<a name="185" href="#185">185</a> <em>     * @param type An Object specifying the type.</em>
<a name="186" href="#186">186</a> <em>     */</em>
<a name="187" href="#187">187</a>     <strong>public</strong> <strong>void</strong> setType(Object type)
<a name="188" href="#188">188</a>     {
<a name="189" href="#189">189</a>         <strong>this</strong>.type = type;
<a name="190" href="#190">190</a>     }
<a name="191" href="#191">191</a> 
<a name="192" href="#192">192</a>     <em>/**<em>*</em></em>
<a name="193" href="#193">193</a> <em>     * Set the Torque type of this column.</em>
<a name="194" href="#194">194</a> <em>     *</em>
<a name="195" href="#195">195</a> <em>     * @param torqueType the Torque type of the column.</em>
<a name="196" href="#196">196</a> <em>     */</em>
<a name="197" href="#197">197</a>     <strong>public</strong> <strong>void</strong> setTorqueType(String torqueType)
<a name="198" href="#198">198</a>     {
<a name="199" href="#199">199</a>         <strong>this</strong>.torqueType = torqueType;
<a name="200" href="#200">200</a>     }
<a name="201" href="#201">201</a> 
<a name="202" href="#202">202</a>     <em>/**<em>*</em></em>
<a name="203" href="#203">203</a> <em>     * Set the size of this column.</em>
<a name="204" href="#204">204</a> <em>     *</em>
<a name="205" href="#205">205</a> <em>     * @param size An int specifying the size.</em>
<a name="206" href="#206">206</a> <em>     */</em>
<a name="207" href="#207">207</a>     <strong>public</strong> <strong>void</strong> setSize(<strong>int</strong> size)
<a name="208" href="#208">208</a>     {
<a name="209" href="#209">209</a>         <strong>this</strong>.size = size;
<a name="210" href="#210">210</a>     }
<a name="211" href="#211">211</a> 
<a name="212" href="#212">212</a>     <em>/**<em>*</em></em>
<a name="213" href="#213">213</a> <em>     * Set if this column is a primary key or not.</em>
<a name="214" href="#214">214</a> <em>     *</em>
<a name="215" href="#215">215</a> <em>     * @param pk True if column is a primary key.</em>
<a name="216" href="#216">216</a> <em>     */</em>
<a name="217" href="#217">217</a>     <strong>public</strong> <strong>void</strong> setPrimaryKey(<strong>boolean</strong> pk)
<a name="218" href="#218">218</a>     {
<a name="219" href="#219">219</a>         <strong>this</strong>.pk = pk;
<a name="220" href="#220">220</a>     }
<a name="221" href="#221">221</a> 
<a name="222" href="#222">222</a>     <em>/**<em>*</em></em>
<a name="223" href="#223">223</a> <em>     * Set if this column may be null.</em>
<a name="224" href="#224">224</a> <em>     *</em>
<a name="225" href="#225">225</a> <em>     * @param nn True if column may be null.</em>
<a name="226" href="#226">226</a> <em>     */</em>
<a name="227" href="#227">227</a>     <strong>public</strong> <strong>void</strong> setNotNull(<strong>boolean</strong> nn)
<a name="228" href="#228">228</a>     {
<a name="229" href="#229">229</a>         <strong>this</strong>.notNull = nn;
<a name="230" href="#230">230</a>     }
<a name="231" href="#231">231</a> 
<a name="232" href="#232">232</a>     <em>/**<em>*</em></em>
<a name="233" href="#233">233</a> <em>     * Set the foreign key for this column.</em>
<a name="234" href="#234">234</a> <em>     *</em>
<a name="235" href="#235">235</a> <em>     * @param fullyQualifiedName The name of the table.column that is</em>
<a name="236" href="#236">236</a> <em>     * foreign.</em>
<a name="237" href="#237">237</a> <em>     */</em>
<a name="238" href="#238">238</a>     <strong>public</strong> <strong>void</strong> setForeignKey(String fullyQualifiedName)
<a name="239" href="#239">239</a>     {
<a name="240" href="#240">240</a>         <strong>if</strong> (fullyQual<strong>if</strong>iedName != <strong>null</strong> &amp;&amp; fullyQual<strong>if</strong>iedName.length() > 0)
<a name="241" href="#241">241</a>         {
<a name="242" href="#242">242</a>             relatedTableName = fullyQualifiedName.substring(
<a name="243" href="#243">243</a>                     0, fullyQualifiedName.indexOf('.'));
<a name="244" href="#244">244</a>             relatedColumnName = fullyQualifiedName.substring(
<a name="245" href="#245">245</a>                     fullyQualifiedName.indexOf('.') + 1);
<a name="246" href="#246">246</a>         }
<a name="247" href="#247">247</a>         <strong>else</strong>
<a name="248" href="#248">248</a>         {
<a name="249" href="#249">249</a>             relatedTableName = <span class="string">""</span>;
<a name="250" href="#250">250</a>             relatedColumnName = <span class="string">""</span>;
<a name="251" href="#251">251</a>         }
<a name="252" href="#252">252</a>     }
<a name="253" href="#253">253</a> 
<a name="254" href="#254">254</a>     <em>/**<em>*</em></em>
<a name="255" href="#255">255</a> <em>     * Set the foreign key for this column.</em>
<a name="256" href="#256">256</a> <em>     *</em>
<a name="257" href="#257">257</a> <em>     * @param tableName The name of the table that is foreign.</em>
<a name="258" href="#258">258</a> <em>     * @param columnName The name of the column that is foreign.</em>
<a name="259" href="#259">259</a> <em>     */</em>
<a name="260" href="#260">260</a>     <strong>public</strong> <strong>void</strong> setForeignKey(String tableName, String columnName)
<a name="261" href="#261">261</a>     {
<a name="262" href="#262">262</a>         <strong>if</strong> (tableName != <strong>null</strong> &amp;&amp; tableName.length() > 0 &amp;&amp; columnName != <strong>null</strong>
<a name="263" href="#263">263</a>                 &amp;&amp; columnName.length() > 0)
<a name="264" href="#264">264</a>         {
<a name="265" href="#265">265</a>             relatedTableName = tableName;
<a name="266" href="#266">266</a>             relatedColumnName = normalizeName(columnName);
<a name="267" href="#267">267</a>         }
<a name="268" href="#268">268</a>         <strong>else</strong>
<a name="269" href="#269">269</a>         {
<a name="270" href="#270">270</a>             relatedTableName = <span class="string">""</span>;
<a name="271" href="#271">271</a>             relatedColumnName = <span class="string">""</span>;
<a name="272" href="#272">272</a>         }
<a name="273" href="#273">273</a>     }
<a name="274" href="#274">274</a> 
<a name="275" href="#275">275</a>     <em>/**<em>*</em></em>
<a name="276" href="#276">276</a> <em>     * Get the type of this column. Note that if usePrimitive is true, this may</em>
<a name="277" href="#277">277</a> <em>     * need to be converted.</em>
<a name="278" href="#278">278</a> <em>     *</em>
<a name="279" href="#279">279</a> <em>     * @return An Object specifying the type.</em>
<a name="280" href="#280">280</a> <em>     */</em>
<a name="281" href="#281">281</a>     <strong>public</strong> Object getType()
<a name="282" href="#282">282</a>     {
<a name="283" href="#283">283</a>         <strong>return</strong> type;
<a name="284" href="#284">284</a>     }
<a name="285" href="#285">285</a> 
<a name="286" href="#286">286</a>     <em>/**<em>*</em></em>
<a name="287" href="#287">287</a> <em>     * Get the name of the Torque type of this column.</em>
<a name="288" href="#288">288</a> <em>     *</em>
<a name="289" href="#289">289</a> <em>     * @return The name of the Torque type of this column.</em>
<a name="290" href="#290">290</a> <em>     */</em>
<a name="291" href="#291">291</a>     <strong>public</strong> String getTorqueType()
<a name="292" href="#292">292</a>     {
<a name="293" href="#293">293</a>         <strong>return</strong> torqueType;
<a name="294" href="#294">294</a>     }
<a name="295" href="#295">295</a> 
<a name="296" href="#296">296</a>     <em>/**<em>*</em></em>
<a name="297" href="#297">297</a> <em>     * The "precision" value from the XML</em>
<a name="298" href="#298">298</a> <em>     * size="&amp;lt;precision&amp;gt;[,&amp;lt;scale&amp;gt;]"</em>
<a name="299" href="#299">299</a> <em>     * attribute. Where [,&amp;lt;scale&amp;gt;] is optional.</em>
<a name="300" href="#300">300</a> <em>     *</em>
<a name="301" href="#301">301</a> <em>     * If the size attribute has not been set in the XML, it will return 0.</em>
<a name="302" href="#302">302</a> <em>     * &lt;p></em>
<a name="303" href="#303">303</a> <em>     *</em>
<a name="304" href="#304">304</a> <em>     * Note that the size="P,S" format should be replaced with size="P"</em>
<a name="305" href="#305">305</a> <em>     * scale="S".</em>
<a name="306" href="#306">306</a> <em>     *</em>
<a name="307" href="#307">307</a> <em>     * @return An int specifying the size.</em>
<a name="308" href="#308">308</a> <em>     */</em>
<a name="309" href="#309">309</a>     <strong>public</strong> <strong>int</strong> getSize()
<a name="310" href="#310">310</a>     {
<a name="311" href="#311">311</a>         <strong>return</strong> size;
<a name="312" href="#312">312</a>     }
<a name="313" href="#313">313</a> 
<a name="314" href="#314">314</a>     <em>/**<em>*</em></em>
<a name="315" href="#315">315</a> <em>     * Is this column a primary key?</em>
<a name="316" href="#316">316</a> <em>     *</em>
<a name="317" href="#317">317</a> <em>     * @return True if column is a primary key.</em>
<a name="318" href="#318">318</a> <em>     */</em>
<a name="319" href="#319">319</a>     <strong>public</strong> <strong>boolean</strong> isPrimaryKey()
<a name="320" href="#320">320</a>     {
<a name="321" href="#321">321</a>         <strong>return</strong> pk;
<a name="322" href="#322">322</a>     }
<a name="323" href="#323">323</a> 
<a name="324" href="#324">324</a>     <em>/**<em>*</em></em>
<a name="325" href="#325">325</a> <em>     * Is null value allowed ?</em>
<a name="326" href="#326">326</a> <em>     *</em>
<a name="327" href="#327">327</a> <em>     * @return True if column may be null.</em>
<a name="328" href="#328">328</a> <em>     */</em>
<a name="329" href="#329">329</a>     <strong>public</strong> <strong>boolean</strong> isNotNull()
<a name="330" href="#330">330</a>     {
<a name="331" href="#331">331</a>         <strong>return</strong> (notNull || isPrimaryKey());
<a name="332" href="#332">332</a>     }
<a name="333" href="#333">333</a> 
<a name="334" href="#334">334</a>     <em>/**<em>*</em></em>
<a name="335" href="#335">335</a> <em>     * Is this column a foreign key?</em>
<a name="336" href="#336">336</a> <em>     *</em>
<a name="337" href="#337">337</a> <em>     * @return True if column is a foreign key.</em>
<a name="338" href="#338">338</a> <em>     */</em>
<a name="339" href="#339">339</a>     <strong>public</strong> <strong>boolean</strong> isForeignKey()
<a name="340" href="#340">340</a>     {
<a name="341" href="#341">341</a>         <strong>return</strong> (relatedTableName != <strong>null</strong> &amp;&amp; relatedTableName.length() > 0);
<a name="342" href="#342">342</a>     }
<a name="343" href="#343">343</a> 
<a name="344" href="#344">344</a>     <em>/**<em>*</em></em>
<a name="345" href="#345">345</a> <em>     * Get the table.column that this column is related to.</em>
<a name="346" href="#346">346</a> <em>     *</em>
<a name="347" href="#347">347</a> <em>     * @return A String with the full name for the related column.</em>
<a name="348" href="#348">348</a> <em>     */</em>
<a name="349" href="#349">349</a>     <strong>public</strong> String getRelatedName()
<a name="350" href="#350">350</a>     {
<a name="351" href="#351">351</a>         <strong>return</strong> relatedTableName + <span class="string">"."</span> + relatedColumnName;
<a name="352" href="#352">352</a>     }
<a name="353" href="#353">353</a> 
<a name="354" href="#354">354</a>     <em>/**<em>*</em></em>
<a name="355" href="#355">355</a> <em>     * Get the table name that this column is related to.</em>
<a name="356" href="#356">356</a> <em>     *</em>
<a name="357" href="#357">357</a> <em>     * @return A String with the name for the related table.</em>
<a name="358" href="#358">358</a> <em>     */</em>
<a name="359" href="#359">359</a>     <strong>public</strong> String getRelatedTableName()
<a name="360" href="#360">360</a>     {
<a name="361" href="#361">361</a>         <strong>return</strong> relatedTableName;
<a name="362" href="#362">362</a>     }
<a name="363" href="#363">363</a> 
<a name="364" href="#364">364</a>     <em>/**<em>*</em></em>
<a name="365" href="#365">365</a> <em>     * Get the column name that this column is related to.</em>
<a name="366" href="#366">366</a> <em>     *</em>
<a name="367" href="#367">367</a> <em>     * @return A String with the name for the related column.</em>
<a name="368" href="#368">368</a> <em>     */</em>
<a name="369" href="#369">369</a>     <strong>public</strong> String getRelatedColumnName()
<a name="370" href="#370">370</a>     {
<a name="371" href="#371">371</a>         <strong>return</strong> relatedColumnName;
<a name="372" href="#372">372</a>     }
<a name="373" href="#373">373</a> 
<a name="374" href="#374">374</a>     <em>/**<em>*</em></em>
<a name="375" href="#375">375</a> <em>     * Gets the scale set for this column (if any) as set in the XML database</em>
<a name="376" href="#376">376</a> <em>     * definition. E.g., the value of the scale attribute or the scale portion</em>
<a name="377" href="#377">377</a> <em>     * of a size="P,S" attribute. (Note: size="P,S" format is being</em>
<a name="378" href="#378">378</a> <em>     * deprecated!).</em>
<a name="379" href="#379">379</a> <em>     *</em>
<a name="380" href="#380">380</a> <em>     * @return Returns the scale.</em>
<a name="381" href="#381">381</a> <em>     */</em>
<a name="382" href="#382">382</a>     <strong>public</strong> <strong>int</strong> getScale()
<a name="383" href="#383">383</a>     {
<a name="384" href="#384">384</a>         <strong>return</strong> scale;
<a name="385" href="#385">385</a>     }
<a name="386" href="#386">386</a> 
<a name="387" href="#387">387</a>     <em>/**<em>*</em></em>
<a name="388" href="#388">388</a> <em>     * @param scale The scale to set.</em>
<a name="389" href="#389">389</a> <em>     */</em>
<a name="390" href="#390">390</a>     <strong>public</strong> <strong>void</strong> setScale(<strong>int</strong> scale)
<a name="391" href="#391">391</a>     {
<a name="392" href="#392">392</a>         <strong>this</strong>.scale = scale;
<a name="393" href="#393">393</a>     }
<a name="394" href="#394">394</a> 
<a name="395" href="#395">395</a>     <em>/**<em>*</em></em>
<a name="396" href="#396">396</a> <em>     * Gets the Java Name for this column as defined in XML or created by</em>
<a name="397" href="#397">397</a> <em>     * generator code.</em>
<a name="398" href="#398">398</a> <em>     *</em>
<a name="399" href="#399">399</a> <em>     * @return the Java Name.</em>
<a name="400" href="#400">400</a> <em>     */</em>
<a name="401" href="#401">401</a>     <strong>public</strong> String getJavaName()
<a name="402" href="#402">402</a>     {
<a name="403" href="#403">403</a>         <strong>return</strong> <strong>this</strong>.javaName;
<a name="404" href="#404">404</a>     }
<a name="405" href="#405">405</a> 
<a name="406" href="#406">406</a>     <em>/**<em>*</em></em>
<a name="407" href="#407">407</a> <em>     * Sets the Java Name for this column.</em>
<a name="408" href="#408">408</a> <em>     *</em>
<a name="409" href="#409">409</a> <em>     * @param name the Java Name.</em>
<a name="410" href="#410">410</a> <em>     */</em>
<a name="411" href="#411">411</a>     <strong>public</strong> <strong>void</strong> setJavaName(String name)
<a name="412" href="#412">412</a>     {
<a name="413" href="#413">413</a>         <strong>this</strong>.javaName = name;
<a name="414" href="#414">414</a>     }
<a name="415" href="#415">415</a> 
<a name="416" href="#416">416</a>     <em>/**<em>*</em></em>
<a name="417" href="#417">417</a> <em>     * Returns whether this column is an autoincrement column.</em>
<a name="418" href="#418">418</a> <em>     *</em>
<a name="419" href="#419">419</a> <em>     * @return true if this column is an autoIncrement column, false otherwise.</em>
<a name="420" href="#420">420</a> <em>     */</em>
<a name="421" href="#421">421</a>     <strong>public</strong> <strong>boolean</strong> isAutoIncrement()
<a name="422" href="#422">422</a>     {
<a name="423" href="#423">423</a>         <strong>return</strong> autoIncrement;
<a name="424" href="#424">424</a>     }
<a name="425" href="#425">425</a> 
<a name="426" href="#426">426</a>     <em>/**<em>*</em></em>
<a name="427" href="#427">427</a> <em>     * Sets whether this column is an autoincrement column.</em>
<a name="428" href="#428">428</a> <em>     *</em>
<a name="429" href="#429">429</a> <em>     * @param autoIncrement whether this colimn is an autoincrement column.</em>
<a name="430" href="#430">430</a> <em>     */</em>
<a name="431" href="#431">431</a>     <strong>public</strong> <strong>void</strong> setAutoIncrement(<strong>boolean</strong> autoIncrement)
<a name="432" href="#432">432</a>     {
<a name="433" href="#433">433</a>         <strong>this</strong>.autoIncrement = autoIncrement;
<a name="434" href="#434">434</a>     }
<a name="435" href="#435">435</a> 
<a name="436" href="#436">436</a>     <em>/**<em>*</em></em>
<a name="437" href="#437">437</a> <em>     * A string representing the default value defined for this column.</em>
<a name="438" href="#438">438</a> <em>     *</em>
<a name="439" href="#439">439</a> <em>     * @return The default value of this column, if any.</em>
<a name="440" href="#440">440</a> <em>     */</em>
<a name="441" href="#441">441</a>     <strong>public</strong> String getDefault()
<a name="442" href="#442">442</a>     {
<a name="443" href="#443">443</a>         <strong>return</strong> defaultValue;
<a name="444" href="#444">444</a>     }
<a name="445" href="#445">445</a> 
<a name="446" href="#446">446</a>     <em>/**<em>*</em></em>
<a name="447" href="#447">447</a> <em>     * Sets the default value for this column.</em>
<a name="448" href="#448">448</a> <em>     *</em>
<a name="449" href="#449">449</a> <em>     * @param defaultValue The defaultValue to set.</em>
<a name="450" href="#450">450</a> <em>     */</em>
<a name="451" href="#451">451</a>     <strong>public</strong> <strong>void</strong> setDefault(String defaultValue)
<a name="452" href="#452">452</a>     {
<a name="453" href="#453">453</a>         <strong>this</strong>.defaultValue = defaultValue;
<a name="454" href="#454">454</a>     }
<a name="455" href="#455">455</a> 
<a name="456" href="#456">456</a>     <em>/**<em>*</em></em>
<a name="457" href="#457">457</a> <em>     * Returns the column description info.</em>
<a name="458" href="#458">458</a> <em>     *</em>
<a name="459" href="#459">459</a> <em>     * @return the description, if any.</em>
<a name="460" href="#460">460</a> <em>     */</em>
<a name="461" href="#461">461</a>     <strong>public</strong> String getDescription()
<a name="462" href="#462">462</a>     {
<a name="463" href="#463">463</a>         <strong>return</strong> description;
<a name="464" href="#464">464</a>     }
<a name="465" href="#465">465</a> 
<a name="466" href="#466">466</a>     <em>/**<em>*</em></em>
<a name="467" href="#467">467</a> <em>     * Sets the description for this column.</em>
<a name="468" href="#468">468</a> <em>     *</em>
<a name="469" href="#469">469</a> <em>     * @param description The description to set.</em>
<a name="470" href="#470">470</a> <em>     */</em>
<a name="471" href="#471">471</a>     <strong>public</strong> <strong>void</strong> setDescription(String description)
<a name="472" href="#472">472</a>     {
<a name="473" href="#473">473</a>         <strong>this</strong>.description = description;
<a name="474" href="#474">474</a>     }
<a name="475" href="#475">475</a> 
<a name="476" href="#476">476</a>     <em>/**<em>*</em></em>
<a name="477" href="#477">477</a> <em>     * Get the inheritance information associated with this column,</em>
<a name="478" href="#478">478</a> <em>     *</em>
<a name="479" href="#479">479</a> <em>     * @return Returns an array of associated inheritanceMap.</em>
<a name="480" href="#480">480</a> <em>     *         The array is in XML order.</em>
<a name="481" href="#481">481</a> <em>     */</em>
<a name="482" href="#482">482</a>     <strong>public</strong> <a href="../../../../org/apache/torque/map/InheritanceMap.html">InheritanceMap</a>[] getInheritanceMaps()
<a name="483" href="#483">483</a>     {
<a name="484" href="#484">484</a>         <a href="../../../../org/apache/torque/map/InheritanceMap.html">InheritanceMap</a>[] iMaps = <strong>new</strong> <a href="../../../../org/apache/torque/map/InheritanceMap.html">InheritanceMap</a>[inheritanceMaps.size()];
<a name="485" href="#485">485</a>         <strong>synchronized</strong> (inheritanceMaps)
<a name="486" href="#486">486</a>         {
<a name="487" href="#487">487</a>             Iterator it = inheritanceMaps.values().iterator();
<a name="488" href="#488">488</a>             <strong>int</strong> i = 0;
<a name="489" href="#489">489</a>             <strong>while</strong> (it.hasNext())
<a name="490" href="#490">490</a>             {
<a name="491" href="#491">491</a>                 iMaps[i++] = (InheritanceMap) it.next();
<a name="492" href="#492">492</a>             }
<a name="493" href="#493">493</a>         }
<a name="494" href="#494">494</a>         <strong>return</strong> iMaps;
<a name="495" href="#495">495</a>     }
<a name="496" href="#496">496</a> 
<a name="497" href="#497">497</a>     <em>/**<em>*</em></em>
<a name="498" href="#498">498</a> <em>     * Add an associated inheritance mapping.</em>
<a name="499" href="#499">499</a> <em>     *</em>
<a name="500" href="#500">500</a> <em>     * @param map The inheritanceMap to associate with this column.</em>
<a name="501" href="#501">501</a> <em>     */</em>
<a name="502" href="#502">502</a>     <strong>public</strong> <strong>void</strong> addInheritanceMap(<a href="../../../../org/apache/torque/map/InheritanceMap.html">InheritanceMap</a> map)
<a name="503" href="#503">503</a>     {
<a name="504" href="#504">504</a>         setUseInheritance(<strong>true</strong>);
<a name="505" href="#505">505</a>         <strong>this</strong>.inheritanceMaps.put(map.getKey(), map);
<a name="506" href="#506">506</a>     }
<a name="507" href="#507">507</a> 
<a name="508" href="#508">508</a>     <em>/**<em>*</em></em>
<a name="509" href="#509">509</a> <em>     * Gets the inheritance type used.</em>
<a name="510" href="#510">510</a> <em>     *</em>
<a name="511" href="#511">511</a> <em>     * @return the inheritance type used.</em>
<a name="512" href="#512">512</a> <em>     */</em>
<a name="513" href="#513">513</a>     <strong>public</strong> String getInheritance()
<a name="514" href="#514">514</a>     {
<a name="515" href="#515">515</a>         <strong>return</strong> inheritance;
<a name="516" href="#516">516</a>     }
<a name="517" href="#517">517</a> 
<a name="518" href="#518">518</a>     <em>/**<em>*</em></em>
<a name="519" href="#519">519</a> <em>     * Sets the inheritance type.</em>
<a name="520" href="#520">520</a> <em>     *</em>
<a name="521" href="#521">521</a> <em>     * @param inheritanceType The inheritance type to set.</em>
<a name="522" href="#522">522</a> <em>     */</em>
<a name="523" href="#523">523</a>     <strong>public</strong> <strong>void</strong> setInheritance(String inheritanceType)
<a name="524" href="#524">524</a>     {
<a name="525" href="#525">525</a>         <strong>this</strong>.inheritance = inheritanceType;
<a name="526" href="#526">526</a>     }
<a name="527" href="#527">527</a> 
<a name="528" href="#528">528</a>     <em>/**<em>*</em></em>
<a name="529" href="#529">529</a> <em>     * Returns the input validator class name.</em>
<a name="530" href="#530">530</a> <em>     * (This property is in the DTD, but currently not used by Torque?)</em>
<a name="531" href="#531">531</a> <em>     *</em>
<a name="532" href="#532">532</a> <em>     * @return Returns the inputValidator.</em>
<a name="533" href="#533">533</a> <em>     */</em>
<a name="534" href="#534">534</a>     <strong>public</strong> String getInputValidator()
<a name="535" href="#535">535</a>     {
<a name="536" href="#536">536</a>         <strong>return</strong> inputValidator;
<a name="537" href="#537">537</a>     }
<a name="538" href="#538">538</a> 
<a name="539" href="#539">539</a>     <em>/**<em>*</em></em>
<a name="540" href="#540">540</a> <em>     * Sets the input validator class name.</em>
<a name="541" href="#541">541</a> <em>     *</em>
<a name="542" href="#542">542</a> <em>     * @param inputValidator The inputValidator to set.</em>
<a name="543" href="#543">543</a> <em>     */</em>
<a name="544" href="#544">544</a>     <strong>public</strong> <strong>void</strong> setInputValidator(String inputValidator)
<a name="545" href="#545">545</a>     {
<a name="546" href="#546">546</a>         <strong>this</strong>.inputValidator = inputValidator;
<a name="547" href="#547">547</a>     }
<a name="548" href="#548">548</a> 
<a name="549" href="#549">549</a>     <em>/**<em>*</em></em>
<a name="550" href="#550">550</a> <em>     * Returns whether getters and setters are generated with the</em>
<a name="551" href="#551">551</a> <em>     * access modifier "protected" rather than "public".</em>
<a name="552" href="#552">552</a> <em>     *</em>
<a name="553" href="#553">553</a> <em>     * @return whether the accessors should be protected rather than public.</em>
<a name="554" href="#554">554</a> <em>     */</em>
<a name="555" href="#555">555</a>     <strong>public</strong> <strong>boolean</strong> isProtected()
<a name="556" href="#556">556</a>     {
<a name="557" href="#557">557</a>         <strong>return</strong> isProtected;
<a name="558" href="#558">558</a>     }
<a name="559" href="#559">559</a> 
<a name="560" href="#560">560</a>     <em>/**<em>*</em></em>
<a name="561" href="#561">561</a> <em>     * Sets whether getters and setters should be generated with the</em>
<a name="562" href="#562">562</a> <em>     * access modifier "protected" rather than "public".</em>
<a name="563" href="#563">563</a> <em>     *</em>
<a name="564" href="#564">564</a> <em>     * @param isProtected whether getters and setters for this column</em>
<a name="565" href="#565">565</a> <em>     *        are protected.</em>
<a name="566" href="#566">566</a> <em>     */</em>
<a name="567" href="#567">567</a>     <strong>public</strong> <strong>void</strong> setProtected(<strong>boolean</strong> isProtected)
<a name="568" href="#568">568</a>     {
<a name="569" href="#569">569</a>         <strong>this</strong>.isProtected = isProtected;
<a name="570" href="#570">570</a>     }
<a name="571" href="#571">571</a> 
<a name="572" href="#572">572</a>     <em>/**<em>*</em></em>
<a name="573" href="#573">573</a> <em>     * Returns whether this column is a primary key.</em>
<a name="574" href="#574">574</a> <em>     *</em>
<a name="575" href="#575">575</a> <em>     * @return whether this column is a primary key.</em>
<a name="576" href="#576">576</a> <em>     */</em>
<a name="577" href="#577">577</a>     <strong>public</strong> <strong>boolean</strong> isPk()
<a name="578" href="#578">578</a>     {
<a name="579" href="#579">579</a>         <strong>return</strong> pk;
<a name="580" href="#580">580</a>     }
<a name="581" href="#581">581</a> 
<a name="582" href="#582">582</a>     <em>/**<em>*</em></em>
<a name="583" href="#583">583</a> <em>     * Sets whether this column is a primary key.</em>
<a name="584" href="#584">584</a> <em>     *</em>
<a name="585" href="#585">585</a> <em>     * @param pk whether this column is a primary key.</em>
<a name="586" href="#586">586</a> <em>     */</em>
<a name="587" href="#587">587</a>     <strong>public</strong> <strong>void</strong> setPk(<strong>boolean</strong> pk)
<a name="588" href="#588">588</a>     {
<a name="589" href="#589">589</a>         <strong>this</strong>.pk = pk;
<a name="590" href="#590">590</a>     }
<a name="591" href="#591">591</a> 
<a name="592" href="#592">592</a>     <em>/**<em>*</em></em>
<a name="593" href="#593">593</a> <em>     * Returns whether this column uses inheritance subclasses.</em>
<a name="594" href="#594">594</a> <em>     *</em>
<a name="595" href="#595">595</a> <em>     * @return true if inheritance subclasses are used, false otherwise.</em>
<a name="596" href="#596">596</a> <em>     */</em>
<a name="597" href="#597">597</a>     <strong>public</strong> <strong>boolean</strong> isUseInheritance()
<a name="598" href="#598">598</a>     {
<a name="599" href="#599">599</a>         <strong>return</strong> useInheritance;
<a name="600" href="#600">600</a>     }
<a name="601" href="#601">601</a> 
<a name="602" href="#602">602</a>     <em>/**<em>*</em></em>
<a name="603" href="#603">603</a> <em>     * Sets whether this column uses inheritance subclasses.</em>
<a name="604" href="#604">604</a> <em>     *</em>
<a name="605" href="#605">605</a> <em>     * @param useInheritance whether this column uses Inheritance subclasses.</em>
<a name="606" href="#606">606</a> <em>     */</em>
<a name="607" href="#607">607</a>     <strong>public</strong> <strong>void</strong> setUseInheritance(<strong>boolean</strong> useInheritance)
<a name="608" href="#608">608</a>     {
<a name="609" href="#609">609</a>         <strong>this</strong>.useInheritance = useInheritance;
<a name="610" href="#610">610</a>     }
<a name="611" href="#611">611</a> 
<a name="612" href="#612">612</a>     <em>/**<em>*</em></em>
<a name="613" href="#613">613</a> <em>     * Get the inheritance map with the specified key.</em>
<a name="614" href="#614">614</a> <em>     *</em>
<a name="615" href="#615">615</a> <em>     * @param key the key of the inheritance map.</em>
<a name="616" href="#616">616</a> <em>     * @return the inheritance map with the specified key, or null if no</em>
<a name="617" href="#617">617</a> <em>     *         inheritance map with the specified key exists in this column.</em>
<a name="618" href="#618">618</a> <em>     */</em>
<a name="619" href="#619">619</a>     <strong>public</strong> <a href="../../../../org/apache/torque/map/InheritanceMap.html">InheritanceMap</a> getInheritanceMap(String key)
<a name="620" href="#620">620</a>     {
<a name="621" href="#621">621</a>         <strong>return</strong> (InheritanceMap) inheritanceMaps.get(key);
<a name="622" href="#622">622</a>     }
<a name="623" href="#623">623</a> 
<a name="624" href="#624">624</a>     <em>/**<em>*</em></em>
<a name="625" href="#625">625</a> <em>     * Returns whether this colum uses primitive values rather than objects.</em>
<a name="626" href="#626">626</a> <em>     *</em>
<a name="627" href="#627">627</a> <em>     * @return true if this colum uses primitive values, false if it uses</em>
<a name="628" href="#628">628</a> <em>     *         objects.</em>
<a name="629" href="#629">629</a> <em>     */</em>
<a name="630" href="#630">630</a>     <strong>public</strong> <strong>boolean</strong> isUsePrimitive()
<a name="631" href="#631">631</a>     {
<a name="632" href="#632">632</a>         <strong>return</strong> usePrimitive;
<a name="633" href="#633">633</a>     }
<a name="634" href="#634">634</a> 
<a name="635" href="#635">635</a>     <em>/**<em>*</em></em>
<a name="636" href="#636">636</a> <em>     * Sets whether this colum uses primitive values rather than objects.</em>
<a name="637" href="#637">637</a> <em>     *</em>
<a name="638" href="#638">638</a> <em>     * @param usePrimitive whether primitive objects are used</em>
<a name="639" href="#639">639</a> <em>     *        rather than objects.</em>
<a name="640" href="#640">640</a> <em>     */</em>
<a name="641" href="#641">641</a>     <strong>public</strong> <strong>void</strong> setUsePrimitive(<strong>boolean</strong> usePrimitive)
<a name="642" href="#642">642</a>     {
<a name="643" href="#643">643</a>         <strong>this</strong>.usePrimitive = usePrimitive;
<a name="644" href="#644">644</a>     }
<a name="645" href="#645">645</a> 
<a name="646" href="#646">646</a>     <em>/**<em>*</em></em>
<a name="647" href="#647">647</a> <em>     * Returns the Java naming method for this column.</em>
<a name="648" href="#648">648</a> <em>     *</em>
<a name="649" href="#649">649</a> <em>     * @return the javaNamingMethod for this column.</em>
<a name="650" href="#650">650</a> <em>     */</em>
<a name="651" href="#651">651</a>     <strong>public</strong> String getJavaNamingMethod()
<a name="652" href="#652">652</a>     {
<a name="653" href="#653">653</a>         <strong>return</strong> javaNamingMethod;
<a name="654" href="#654">654</a>     }
<a name="655" href="#655">655</a> 
<a name="656" href="#656">656</a>     <em>/**<em>*</em></em>
<a name="657" href="#657">657</a> <em>     * Sets the java naming method for this column.</em>
<a name="658" href="#658">658</a> <em>     *</em>
<a name="659" href="#659">659</a> <em>     * @param javaNamingMethod The javaNamingMethod to set.</em>
<a name="660" href="#660">660</a> <em>     */</em>
<a name="661" href="#661">661</a>     <strong>public</strong> <strong>void</strong> setJavaNamingMethod(String javaNamingMethod)
<a name="662" href="#662">662</a>     {
<a name="663" href="#663">663</a>         <strong>this</strong>.javaNamingMethod = javaNamingMethod;
<a name="664" href="#664">664</a>     }
<a name="665" href="#665">665</a> 
<a name="666" href="#666">666</a>     <em>/**<em>*</em></em>
<a name="667" href="#667">667</a> <em>     * Returns the map for the table this column belongs to.</em>
<a name="668" href="#668">668</a> <em>     *</em>
<a name="669" href="#669">669</a> <em>     * @return the table map for this column.</em>
<a name="670" href="#670">670</a> <em>     */</em>
<a name="671" href="#671">671</a>     <strong>public</strong> <a href="../../../../org/apache/torque/map/TableMap.html">TableMap</a> getTable()
<a name="672" href="#672">672</a>     {
<a name="673" href="#673">673</a>         <strong>return</strong> table;
<a name="674" href="#674">674</a>     }
<a name="675" href="#675">675</a> 
<a name="676" href="#676">676</a>     <em>/**<em>*</em></em>
<a name="677" href="#677">677</a> <em>     * Returns the position (one based) of this column in the table.</em>
<a name="678" href="#678">678</a> <em>     * XML order is preserved.</em>
<a name="679" href="#679">679</a> <em>     *</em>
<a name="680" href="#680">680</a> <em>     * @return The position of this column, one-based.</em>
<a name="681" href="#681">681</a> <em>     */</em>
<a name="682" href="#682">682</a>     <strong>public</strong> <strong>int</strong> getPosition()
<a name="683" href="#683">683</a>     {
<a name="684" href="#684">684</a>         <strong>return</strong> position;
<a name="685" href="#685">685</a>     }
<a name="686" href="#686">686</a> 
<a name="687" href="#687">687</a>     <em>/**<em>*</em></em>
<a name="688" href="#688">688</a> <em>     * Sets the position (one based) of this column in the table.</em>
<a name="689" href="#689">689</a> <em>     *</em>
<a name="690" href="#690">690</a> <em>     * @param position The position to set.</em>
<a name="691" href="#691">691</a> <em>     */</em>
<a name="692" href="#692">692</a>     <strong>public</strong> <strong>void</strong> setPosition(<strong>int</strong> position)
<a name="693" href="#693">693</a>     {
<a name="694" href="#694">694</a>         <strong>this</strong>.position = position;
<a name="695" href="#695">695</a>     }
<a name="696" href="#696">696</a> 
<a name="697" href="#697">697</a>     <em>/**<em>*</em></em>
<a name="698" href="#698">698</a> <em>     * Returns the java type of this column.</em>
<a name="699" href="#699">699</a> <em>     *</em>
<a name="700" href="#700">700</a> <em>     * @return the javaType.</em>
<a name="701" href="#701">701</a> <em>     */</em>
<a name="702" href="#702">702</a>     <strong>public</strong> String getJavaType()
<a name="703" href="#703">703</a>     {
<a name="704" href="#704">704</a>         <strong>return</strong> javaType;
<a name="705" href="#705">705</a>     }
<a name="706" href="#706">706</a> 
<a name="707" href="#707">707</a>     <em>/**<em>*</em></em>
<a name="708" href="#708">708</a> <em>     * Sets the java type of this column.</em>
<a name="709" href="#709">709</a> <em>     *</em>
<a name="710" href="#710">710</a> <em>     * @param javaType The javaType to set.</em>
<a name="711" href="#711">711</a> <em>     */</em>
<a name="712" href="#712">712</a>     <strong>public</strong> <strong>void</strong> setJavaType(String javaType)
<a name="713" href="#713">713</a>     {
<a name="714" href="#714">714</a>         <strong>this</strong>.javaType = javaType;
<a name="715" href="#715">715</a>     }
<a name="716" href="#716">716</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

